/*
 * Copyright (C) 2009-2011 Knowings
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 3
 * as published by the Free Software Foundation.
 *

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package com.knowings.tbs.transformation;

import java.util.List;

import com.knowings.tbs.operation.IParamInstance;
import com.knowings.tbs.persistence.IPersistent;
import com.knowings.tbs.trace.ITransformedTrace;

/**
 * Object representing a Transformation execution resulting in a Trace.
 * 
 * @author privarola
 */
public interface ITransformationExecution extends IPersistent {

  /**
   * Method returning the computed trace bearing this transformation execution.
   * @return the <code>ITransformedTrace</code> obtained as a result of this execution
   */
  public ITransformedTrace getResultingTrace();

  /**
   * Method returning the list of the UIDs of the traces used as input for this transformation.
   * These traces may not exist any more in the repository if they have been removed.
   * @return the UIDs of the source traces of the transformation
   */
  public List<String> getSourceTraces();

  /**
   * Method returning the UID of the transformation used to run this operation.
   * The transformation instance may not exist any more in the trace repository.
   * @return the UID of the transformation used to run this operation
   */
  public String getTransformationUID();

  /**
   * Return the values of the parameters used to run this transformation.
   * @return a list containing all given or default parameters.
   */
  public List<IParamInstance> getParameters();

  /**Returns an enumeration value depending on the way the transformed trace has been computed. 
   * @return an ExecutionMode enum value, it shouldn't be null;
   */
  public ExecutionMode getExecutionMode();
}
